Propose Documentation for Software Best Practices, Coding Conventions, and Style #1504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gerickson
requested review from
andy31415,
anush-apple,
BroderickCarlin,
chrisdecenzo,
hawk248,
jelderton,
robszewczyk,
saurabhst and
woody-apple
as code owners
saurabhst
approved these changes
Jul 8, 2020
woody-apple
requested changes
Jul 8, 2020
| shared infrastructure bears the least flexibility and bears the greatest | ||
| adherence to these guidelines. | ||
|
|
||
| image:CODING_STYLE_GUIDE-figure1.png[Figure 1. Graphical summary of the |
There was a problem hiding this comment.
I'm not sure that we should say that C++ is required, and straight C is not ok? (Maybe I'm reading this diagram incorrectly).
Maybe we can just remove this diagram, and/or make C allowed in all boxes?
There was a problem hiding this comment.
Updated the diagram to show / allow C/C++ in C++ contexts.
BroderickCarlin
approved these changes
Jul 8, 2020
woody-apple
approved these changes
Jul 9, 2020
andy31415
approved these changes
Jul 9, 2020
jmartinez-silabs
pushed a commit
to SiliconLabs/matter
that referenced
this pull request
Feb 15, 2024
Merge in WMN_TOOLS/matter from documentation/port_changes_back to silabs Squashed commit of the following: commit 803031a4a0194fdca7ebf4d3bd6097f884f8f2d6 Author: Curtis Rahman <[email protected]> Date: Thu Jan 25 15:29:13 2024 -0500 Added back removed last release new features commit 4131dcf57c030f876816295e9efc25f660bcdd04 Author: Curtis Rahman <[email protected]> Date: Thu Jan 18 15:47:27 2024 -0500 Ported back changes
jmartinez-silabs
pushed a commit
to SiliconLabs/matter
that referenced
this pull request
May 8, 2024
Merge in WMN_TOOLS/matter from documentation/port_changes_back to silabs Squashed commit of the following: commit 803031a4a0194fdca7ebf4d3bd6097f884f8f2d6 Author: Curtis Rahman <[email protected]> Date: Thu Jan 25 15:29:13 2024 -0500 Added back removed last release new features commit 4131dcf57c030f876816295e9efc25f660bcdd04 Author: Curtis Rahman <[email protected]> Date: Thu Jan 18 15:47:27 2024 -0500 Ported back changes
rcasallas-silabs
pushed a commit
to rcasallas-silabs/connectedhomeip
that referenced
this pull request
Jun 20, 2024
Merge in WMN_TOOLS/matter from documentation/port_changes_back to silabs Squashed commit of the following: commit 803031a4a0194fdca7ebf4d3bd6097f884f8f2d6 Author: Curtis Rahman <[email protected]> Date: Thu Jan 25 15:29:13 2024 -0500 Added back removed last release new features commit 4131dcf57c030f876816295e9efc25f660bcdd04 Author: Curtis Rahman <[email protected]> Date: Thu Jan 18 15:47:27 2024 -0500 Ported back changes
rcasallas-silabs
pushed a commit
to rcasallas-silabs/connectedhomeip
that referenced
this pull request
Jun 20, 2024
Merge in WMN_TOOLS/matter from documentation/port_changes_back to silabs Squashed commit of the following: commit 803031a4a0194fdca7ebf4d3bd6097f884f8f2d6 Author: Curtis Rahman <[email protected]> Date: Thu Jan 25 15:29:13 2024 -0500 Added back removed last release new features commit 4131dcf57c030f876816295e9efc25f660bcdd04 Author: Curtis Rahman <[email protected]> Date: Thu Jan 18 15:47:27 2024 -0500 Ported back changes
chirag-silabs
pushed a commit
to rosahay-silabs/connectedhomeip
that referenced
this pull request
Jul 15, 2024
Merge in WMN_TOOLS/matter from documentation/port_changes_back to silabs Squashed commit of the following: commit 803031a4a0194fdca7ebf4d3bd6097f884f8f2d6 Author: Curtis Rahman <[email protected]> Date: Thu Jan 25 15:29:13 2024 -0500 Added back removed last release new features commit 4131dcf57c030f876816295e9efc25f660bcdd04 Author: Curtis Rahman <[email protected]> Date: Thu Jan 18 15:47:27 2024 -0500 Ported back changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
CHIP will be composed of much software contributed from participating member organizations. However, for any new CHIP code, there should be documentation for software best practices, coding conventions, and style.
Summary of Changes
Proposed a minimal framework for a documentation guide, in AsciiDoc format, for software best practices, coding conventions, and style.
This reflects this conversation snippet on a prior, broader-scope approach to this document in that it restricts the initial framework to essentially one simple maxim: "When in Rome, do as the Romans do.". We can add from here as repetition and consensus dictate.
Fixes #335